Skip to content

docs(ui-kit/react): reorganize v7 as default with consolidated structure#393

Open
PrajwalDhuleCC wants to merge 27 commits into
mainfrom
docs/v7-docs-update
Open

docs(ui-kit/react): reorganize v7 as default with consolidated structure#393
PrajwalDhuleCC wants to merge 27 commits into
mainfrom
docs/v7-docs-update

Conversation

@PrajwalDhuleCC

Copy link
Copy Markdown
Contributor

Description

  • Update default version from v6 to v7 in docs.json
  • Consolidate integration guides into single files (integration-react, integration-nextjs, integration-react-router, integration-astro)
  • Reorganize component documentation under components/ subdirectory
  • Restructure plugin documentation under plugins/ subdirectory
  • Consolidate guides into focused feature-based documentation
  • Update navigation paths to reflect new file organization
  • Remove duplicate v7-specific documentation directory
  • Clean up legacy changelog link and consolidate links section
  • Rename navigation labels for consistency (React-Router → React Router)
  • Consolidate localization documentation under single theming section

Related Issue(s)

Type of Change

  • Documentation correction/update
  • New documentation
  • Improvement to existing documentation
  • Typo fix
  • Other (please specify)

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working
  • My changes are accurately described in this pull request

Additional Information

Screenshots (if applicable)

- Update default version from v6 to v7 in docs.json
- Consolidate integration guides into single files (integration-react, integration-nextjs, integration-react-router, integration-astro)
- Reorganize component documentation under components/ subdirectory
- Restructure plugin documentation under plugins/ subdirectory
- Consolidate guides into focused feature-based documentation
- Update navigation paths to reflect new file organization
- Remove duplicate v7-specific documentation directory
- Clean up legacy changelog link and consolidate links section
- Rename navigation labels for consistency (React-Router → React Router)
- Consolidate localization documentation under single theming section
@mintlify

mintlify Bot commented Jun 12, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cometchat 🟢 Ready View Preview Jun 12, 2026, 1:14 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

- Add newOwner and previousOwnerUid fields to ui:group/ownership-changed event payload across all affected components
- Update group-members.mdx with new event definition and payload documentation
- Update groups.mdx event payload and subscription table
- Update message-header.mdx event payload and subscription table
- Update message-list.mdx subscription table
- Update event-system.mdx with complete payload schema including new fields
- Ensures consistent ownership change event structure across all components that subscribe to this event
- Fix internal documentation links to include `/v6/` path segment across all v6 documentation files
- Update cross-references in ai-assistant-chat, ai-features, and all integration guide files
- Ensure links point to v6-specific documentation pages instead of root-level pages
- Improve navigation consistency and prevent broken cross-references within v6 documentation
- Add CallLogRequestBuilder reference to call-logs filtering documentation
- Add ConversationsRequestBuilder reference to conversations filtering documentation
- Add GroupMembersRequestBuilder reference to group-members filtering documentation
- Add GroupsRequestBuilder reference to groups filtering documentation
- Add MessagesRequestBuilder reference to message-list filtering documentation
- Add UsersRequestBuilder reference to users filtering documentation
- Clarify CometChatUIKit as a wrapper around Chat SDK methods in methods overview
- Improve documentation by linking to relevant SDK builder API documentation for better discoverability
- Add reference link to REST API in authentication note for token generation
- Add new note about localStorage as default session storage mechanism
- Add "Setting Session Storage Mode" section with code examples showing UIKitSettingsBuilder configuration
- Include example for both direct initialization and CometChatProvider usage
- Add note explaining session storage lifecycle and use cases
- Clarify storage mode options for developers implementing custom authentication flows
- Update npm install command to use @cometchat/chat-uikit-react@6 in astro-integration.mdx
- Update npm install command to use @cometchat/chat-uikit-react@6 in next-js-integration.mdx
- Update npm install command to use @cometchat/chat-uikit-react@6 in react-js-integration.mdx
- Update npm install command to use @cometchat/chat-uikit-react@6 in react-router-integration.mdx
- Ensures users install the correct v6 version when following integration guides
… from plugin documentation

- Remove "Bubble Rendering" section from ai, audio, call-action, collaborative-document, collaborative-whiteboard, delete, file, group-action, image, polls, stickers, text, and video plugins
- Remove "CSS Selectors" reference tables from all affected plugin documentation files
- Consolidate plugin overview to reference component documentation directly instead of duplicating bubble implementation details
- Simplify plugin docs to focus on plugin responsibilities rather than component-level rendering details
- Bubble documentation is now maintained centrally in component documentation, reducing duplication across plugin guides
… + login + CometChatProvider approach

- Move CometChatUIKit initialization from CometChatProvider props to useEffect hook
- Add UIKitSettingsBuilder for centralized configuration management
- Implement proper async initialization with loading states across all framework integrations
- Update Astro, Next.js, React, and React Router example code to use new pattern
- Replace inline provider props (appId, region, authKey, uid) with UIKitSettingsBuilder setup
- Add ready state checks to prevent rendering before SDK initialization completes
- Standardize login flow across conversation, one-to-one, and tab-based chat examples
- Update plugin documentation and integration guides to reflect new initialization approach
- Restructure documentation to distinguish between global config and component-level props
- Add detailed table explaining `disableSoundForMessages`, `customSoundForMessages`, `disableSoundForCalls`, and `customSoundForCalls` properties
- Update quick reference table to show global config approach via `CometChatProvider`
- Document component-level override pattern with examples for `CometChatConversations`, `CometChatMessageList`, `CometChatMessageComposer`, `CometChatIncomingCall`, and `CometChatOutgoingCall`
- Add clarification note that component props take precedence over global config
- Consolidate "Disabling Sounds" section into "Disabling & Customizing Sounds" with two-level configuration hierarchy
raj-dubey1
raj-dubey1 previously approved these changes Jun 19, 2026
@raj-dubey1 raj-dubey1 requested review from adityagokula2210 and removed request for swapnil-cometchat June 19, 2026 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

3 participants